Skip to content

docs: revert adopting JSX comments#11119

Merged
anakin87 merged 2 commits intomainfrom
docs-reversion
Apr 16, 2026
Merged

docs: revert adopting JSX comments#11119
anakin87 merged 2 commits intomainfrom
docs-reversion

Conversation

@anakin87
Copy link
Copy Markdown
Member

@anakin87 anakin87 commented Apr 16, 2026 •
edited
Loading

This reverts commits 8d9df4c and 2b1ca62

Related Issues

I proposed adopting JSX comments in #11104. This was implemented in #11117.

Unfortunately, converting docstrings to Markdown produces invalid JSX comments. So now Vercel build fails: https://vercel.com/deepset-ai/haystack-docs/2eZeFeppTz6eS2VhQKi9wzXQLcjx

Proposed Changes:

  • revert recent changes to make Vercel production builds work again

How did you test it?

Vercel. Vercel build now works again.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 16, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Apr 16, 2026 10:00am

Request Review

@github-actions github-actions Bot added the type:documentation Improvements on the docs label Apr 16, 2026
@anakin87 anakin87 added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Apr 16, 2026
@anakin87 anakin87 marked this pull request as ready for review April 16, 2026 10:01
@anakin87 anakin87 requested a review from a team as a code owner April 16, 2026 10:01
@anakin87 anakin87 requested review from julian-risch and removed request for a team April 16, 2026 10:01
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Apr 16, 2026

Coverage Report for CI Build 24504030459

Warning

No base build found for commit 8d9df4c on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 92.856%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →

Coverage Stats

Coverage Status
Relevant Lines: 17203
Covered Lines: 15974
Line Coverage: 92.86%
Coverage Strength: 0.93 hits per line
💛 - Coveralls

@anakin87 anakin87 enabled auto-merge (squash) April 16, 2026 10:05
@anakin87 anakin87 mentioned this pull request Apr 16, 2026
Open
@anakin87 anakin87 merged commit 07e8c9b into main Apr 16, 2026
36 of 39 checks passed
@anakin87 anakin87 deleted the docs-reversion branch April 16, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bilgeyucel bilgeyucel bilgeyucel approved these changes

@julian-risch julian-risch Awaiting requested review from julian-risch julian-risch is a code owner automatically assigned from deepset-ai/open-source-engineering

Assignees

No one assigned

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes. type:documentation Improvements on the docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anakin87 @coveralls @bilgeyucel